home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / prview16.zip / PREVIEW.DOC < prev    next >
Text File  |  1993-03-07  |  15KB  |  322 lines
  1. GIF Previewer Ver 1.3
  2.  
  3. The GIF Previewer Door is a door written that allows a user to select up to
  4. 79 GIFs and create one GIF and download that GIF so he/she can examine the
  5. GIFs to see if they really want to download these GIFs.
  6.  
  7. Preview Features:
  8.  
  9.    1. Entry of a logo into the array created
  10.    2. File search and listing capabilities
  11.    3. External transfer protocol support
  12.    4. Custom menus & help screens
  13.  
  14.  
  15. Set Up
  16.  
  17.    1. Create a config file that contains the following information
  18.       1 - Complete path to door.sys file
  19.           (See operations section for file types supported.)
  20.       2 - The name of your BBS
  21.       3 - Sysop's first name
  22.       4 - Sysop's last name
  23.  
  24. ====[  This section is imperitive.  ]==========================================
  25.  
  26. NOTE: There are 2 additional lines necessary when using GTUSER.BBS. Since
  27.       this file does not provide the ComPort% and NodeNum% variables, advise
  28.       your Door users to add them to this .CFG file on lines 5 and 6
  29.       respectively. Both variables will default to 1.
  30.  
  31. ===============================================================================
  32.  
  33.       5 - Complete path to the work directory that Preview will place the
  34.           arrays for download.  This directory must be dedicated to Preview as
  35.           it erased every time the door is run.  This directory is also used as
  36.           a scratch dir for Preview.
  37.       6 - Complete path and file name to Preview main menu
  38.       7 - Complete path and file name to Preview dir menu
  39.       8 - Complete path and file name to Preview welcome screen
  40.       9 - Complete path Preview help subdirectory.  Note that the traling slash
  41.           must be given.  See the included config file
  42.      10 - Total number of PCB index files to process
  43.      11 - Complete path and file name to PCB index file or blank if not
  44.           operating under PCB or you do not desire to use PCB's index
  45.           capability.
  46.      12 - Name of GIF created by GIFDESK.  Limited to six characters or less.
  47.           As each collage is created, it is named COLLAG1, COLLAG2, ECT...
  48.      13 - The total number of GIFs allowed per collage.  See Operations section
  49.           for more information.
  50.      14 - The total number of GIF directories that the door will process
  51.      15 - Complete path and file name of first GIF DIR file
  52.      16 - Complete path to GIF directory that is linked to entry 12
  53.      17,18 - Same as 15 and 16
  54.  
  55.       If you have an entry of 4 in line 14 then you must have 8 entries
  56.       following.  Each two lines after line 14 is the board DIR file and it's
  57.       linked directory.  A sample config file is included.
  58.  
  59.    3. Create the file PROT.DAT in the PREVIEW directory.  This file is the list
  60.       of transfer protocols, their corresponding letter in the protocol menu
  61.       displayed to users, the batch file calling the protocol and whether the
  62.       protocol is batch transfer capable.  See the Operations section for the
  63.       exact lay out of this file.
  64.  
  65.    4. Create a file to execute the Preview Door
  66.  
  67.       @ECHO OFF
  68.       CD D:\PCB1\DOORS\PREVIEW
  69.       PREVIEW PREVIEW.CFG
  70.       BOARD1
  71.  
  72.    5. Add the Preview Door entry to your doors list file
  73.  
  74. ====[  This section is imperitive.  ]==========================================
  75. =                                                                              =
  76. =  6. Set the environment variable GIFDESK=FILE.  This is required so GIFDesk =
  77. =  can opearte under any graphics card/monitor configuration to include a     =
  78. =  monochrome system.  I recommend setting this variable in you AUTOEXEC.BAT  =
  79. =  file.  Please note that if this envirnment variable is not set, the door   =
  80. =  will not operate properly if at all!                                       =
  81. =                                                                             =
  82. ===============================================================================
  83.  
  84. Operation
  85.  
  86.       There are certain circumstances that will override the total number of
  87.       GIFs per collage specified in the configuration file.  If the user has
  88.       selected a 640x480 resolution, then the collage is limited to 29 GIFs.
  89.       If the user has selcted 800x600 resolution then the collage is limited to
  90.       47 GIFs and if the user has selected 1024x768, then up to 79 GIFs per
  91.       collage can be created.  Please note that 640x480 is the default.
  92.  
  93. NOTE: The following sysop functions are available when a user is logged in
  94.       PREVIEW
  95.  
  96.       F3 - Toggle Printer On/Off
  97.       F4 - Toggle Sysop Page Status
  98.       F5 - Shell to DOS
  99.       F7 - Toggle Caller Alarm
  100.       F8 - Dump User Back To BBS
  101.       F9 - Toggle Display On/Off
  102.       F10 - Initiate Sysop Chat.  When in chat mode, ESC will terminate chat
  103.       ALT N - Sets Sysop On Next Flag
  104.       ALT X - Sets Exit To DOS flag
  105.       Up Arrow - Increase User Time
  106.       Dn Arrow - Decrease User Time
  107.       Rt Arrow - Increase User Security Level
  108.       Lt Arrow - Decrease User Security Level
  109.  
  110.    If a user selects 3 or fewer GIFs then Preview will create a four GIF array
  111.    and if he/she selects between 4 and 8, Preview will create a nine GIF array.
  112.    If the user selects nine or more GIFs, Previewer will create a 30, 48 or 80
  113.    array GIF depending on what resolution (s)he has selcted. When 29 GIFs at
  114.    640x480 resolution are selected, the GIF created will be about 90K.
  115.  
  116.    If you wish to include a logo in each array generated then create a GIF and
  117.    place it in the Preview work directory.  This GIF must be named A.GIF.  This
  118.    is currently hard coded into Preview so it will be the first GIF in the
  119.    array.  This was done because GIFDESK sorts the GIFs in the array and there
  120.    is currently no way to prevent this.  I recommend a simple logo with two or
  121.    three colors so it will always look relatively the same for each array
  122.    generated.
  123.  
  124.    All custom screens support an ansi version by appending a g to the file name
  125.    specified in the config file.  For example, if you had a menu screen called
  126.    MENU then to send an ansi version of that screen create that screen and name
  127.    it MENUG.
  128.  
  129. ====[ This section is imperitive  ]============================================
  130.  
  131.    When saving ansi screens, use the Block Save function when using TheDraw or
  132.    the equivelent for whatever ansi pgm you are using.  When marking the block,
  133.    do not use column 80.  Also use no video preperation when saving the file.
  134.    All screens are customizable.
  135.  
  136. ===============================================================================
  137.  
  138.    Preview has the capability to utilize PCBoard's file indexs to speed up
  139.    operations as well as save wear and tear on CD Roms and hard drives.  To
  140.    utilize this, set entry 10 in the config file to the total number of indexes
  141.    you will use.  Then provide the complete path and file name for each index.
  142.    If you aren't operating under PCB or do not desire to use index files,
  143.    then set entry 10 to 1 and leave the following entry blank.  Note that when
  144.    operating under PCB and utilizing the index capability, the wild card
  145.    function does not support the question mark, only the asterik.  This is not
  146.    true if your not using the index file.  Both the question mark and asterik
  147.    are supported.
  148.  
  149.    Set up on a multitasking or network environemnt is painless.  Simply create
  150.    a separate work directory for each node and create an individual config file
  151.    for each node as well.
  152.  
  153.    THE PROT.DAT file consists of four entries per line.  The first entry is the
  154.    letter selecting the protocol, the second entry is the actual batch file
  155.    calling the external protocol, the third entry is the description of the
  156.    protocol displayed in the protocol menu and the fourth entry is whether or
  157.    not the protocol is batch capable.  The PROT.DAT file can contain up to 15
  158.    separate protocols.  A sample file is included along with the calling batch
  159.    files.  Four variables are passed to the batch file: %1 is the active comm
  160.    port, %2 is the callers connect speed, %3 is the file name and %4 is the
  161.    computer to modem connect speed.  Sample batch files utilizing DSZ are
  162.    provided for XModem, XModem-1K, YModem(g) and ZModem
  163.  
  164.    The door currently supports six different door file types:
  165.  
  166.       PCBOARD.SYS  - PCBoard 14.5a
  167.       CALLINFO.BBS - Wildcat system prior to ver 3
  168.       USERINFO.BBS - Wildcat systems ver 3.x
  169.       DOOR.SYS     - For systems that support DOOR.SYS
  170.       DORINFOx.DEF - QBBS/RBBS/RA (change x to reflect node number)
  171.       SFDOORS.DAT  - Spitfire systems
  172.  
  173.     PREVIEW has been tested to operate succesfully on PCB, Wildcat, and VBBS
  174.     systems. The only consideration to operate on a non PCB system is the text
  175.     file that is linked to each GIF dir.  Simply create a text file from your
  176.     DIR files. The only requirement is that only file names be in column 1. PCB
  177.     systems do not have to create seperate text files, they can use their
  178.     existing DIR files.  All other systems must create a text file for each GIF
  179.     dir.
  180.  
  181.     The door supports standard comm ports 1 - 4
  182.  
  183.       Port 3 on 3E8/IRQ4 and Port 4 on 2E8/IRQ3
  184.  
  185.       Non-standard comm port interrupts are also supported.  To utilize IRQ 5
  186.       your command line to call the door should look like this:
  187.  
  188.       PREVIEW PREVIEW.CFG /5
  189.  
  190.       If your using DSZ/GSZ to support the file transfers then your batch file
  191.       to call DSZ using COM 3 on address 3E8 using interrupt 5 should look
  192.       something like this:
  193.  
  194.       DSZ ha bo portx 3E8,5 est 0 %2 sz %3.
  195.  
  196.       Batch files for standard com ports are provided.  If you use non-standard
  197.       IRQs then I suggest reading the docs that came with your protocol.
  198.  
  199.    The following files must be in your DOS path, GIFDESK.EXE and the batch files
  200.    that call each seperate transfer protocol.
  201.  
  202. Commands Available In Door
  203.  
  204.     F - Display file directories. Displays a menu in which the user selects
  205.         what DIR file to display.  Once the user has selected the DIR file,
  206.         then (s)he select files to put in the collage.  Standard DOS wild cards
  207.         are supported when selecting files.
  208.  
  209.         Available in registered veriosn only.
  210.  
  211.         *More than one name can be given at a time. For example, ASBI000?
  212.         ASVI000? will place all files matching that criteria in the collage.
  213.         Up to ten different names can be given at one time
  214.  
  215.     C - Once the user has selected files for the collage, he uses this command
  216.         to create the collage.
  217.  
  218.     D - This allows the user to download the collage created.  If more than one
  219.         collage was made and the user selects a batch capable protocol then no
  220.         further intervention is neseccary.  If the user selects a non batch
  221.         capable protocol and has created more than one collage then (s)he must
  222.         be there to start each individual transfer.
  223.  
  224.     H - Help, displays help file
  225.  
  226.     R - Return to BBS.  Door will issue warning if user has selected files for
  227.         a collage or has created a collage and not downloaded it.
  228.  
  229.     S - Allows the user to search all file directories on a key word.  If the
  230.         key word is found then the GIF file and it's entire description is
  231.         displayed.
  232.  
  233.     E - Allows user to enter a file name to add to the collage.  Standard DOS
  234.         wild cards are supported as well as multiple file names.  Please review
  235.         command F for more details on wild cards and multiple file
  236.         specifications.
  237.  
  238. *   I - Allows the user to increase the resolution output of the collage
  239.         created.  This in turn allows more GIFs per collage.
  240.  
  241. *   K - Allows the user to decrease the resolution output of the collage
  242.         created.
  243.  
  244. *EDIT - Allows the user to remove GIFs from the collage that (s)he has
  245.         previously selected.  The user is shown a list of GIFs currently
  246.         selected and (s)he supplies the number of the GIF to remove.  If the
  247.         user enters ALL, then all GIFs are removed from the collage.
  248.  
  249. Note - Items with an * next to them are available in the registered version
  250.        only.  But note, all features are available when the sysop is logged
  251.        into the door so (s)he can make a proper evaluation of the door.
  252.  
  253.  
  254. In the Future
  255.  
  256.     Create own index utility to improve operations under all BBS types.
  257.  
  258. Warranty
  259.  
  260.     This product is provided "as is" without warranty of any kind. The entire
  261.     risk as to the results and  performance of the program is assumed by you.
  262.     Futhermore, the  author does  not warrant, guarantee, or  make any  other
  263.     representations regarding  the use of,  or the  results of the use of the
  264.     program,  and you  rely on the  program and  results  solely at  your own
  265.     risk.  The author can not and  will not accept  responsibility for system
  266.     damage, loss of profit, or any other special, consequential or incidental
  267.     damages  resulting  from  the  use  or  inability  to  use this  product.
  268.  
  269. Copyright
  270.  
  271.     GIF Previewer Copyright (c) 1992,93 by  Chris Gifford  is being distributed
  272.     as Shareware. Under this concept you may use the  SHAREWARE  (unregistered)
  273.     version for a reasonable period of  time for evaluation  after which you
  274.     must either register your copy or discontinue  usage.  This time period is
  275.     set for 30 days.
  276.  
  277. Registration:
  278.  
  279.     Registration gets you support via tha Antares Sector BBS (801) 544-7613.
  280.     A registration fee of $20 is required.  Please send all registrations to:
  281.  
  282.       Chris Gifford
  283.       189 S. Main, #40
  284.       Layton, UT  84041
  285.  
  286.     Please include exactly how you want your name to appear when the door first
  287.     opens.  You are limited to 35 characters or less.  Please include your BBS
  288.     number so I can upload the latest version of PREVIEW and the key to remove
  289.     to opening delay.
  290.  
  291.     Once you have registered and obtained your key then place the key in the
  292.     PREVIEW home directory.
  293.  
  294. Support
  295.  
  296.     I believe in supporting any software that I develop, whether the user has
  297.     registered the software or not.  Support for PREVIEW can be obtained at two
  298.     different BBS's:
  299.  
  300.     The Antares Sector (801) 544-7613 USR HST D/S
  301.                        (801) 544-7576 12/24 BPS
  302.  
  303.     The GIFfer BBS - (813) 969-2761 14.4
  304.                      (813) 969-2956 14.4
  305.                      (813) 969-1829 14.4
  306.                      (813) 969-1089 14.4
  307.  
  308.     If you use the GIFfer BBS for Preview support, please leave all messages to
  309.     Robert Perreault.
  310.  
  311. Credits
  312.  
  313.    Preview was developed under DFRAME, a doors development kit for MS Basic 7.X
  314.    PDS and is copyrighted by Ted Freeman of MicroNet BBS (615) 690-0424.
  315.  
  316.    All trademarks are copyrighted by their respective owners.
  317.  
  318.    Credit where credit is due:
  319.  
  320.    Many thanks go to Robert Perreault.  With out his help and input PREVIEW
  321.    would not have come along as fast as it has.
  322.